LDoc - это Генератор документации Lua предназначенный для совместимости с
LuaDoc и, следовательно, следует шаблону, установленному различными
инструментами Doc:

\--- Резюме заканчивается точкой.
\- Некоторое описание, может быть в несколько строк.
\- @param p1 первый параметр
\- @param p2 второй параметр
\- @ вернуть строковое значение
\- @see second_fun
функция mod1.first_fun (p1, p2)
конец

Поддерживаются такие теги, как «видеть» и «использование», и, как правило, из
кода можно вывести имена функций и модулей.

LDoc разработан для обеспечения лучшей диагностики: если ссылка @see не может
быть найдена, то указывается номер строки ссылки. LDoc знает о модулях,
которые не используют module (). Это важно, так как эта функция устарела в Lua
5.2. И вы можете избежать необходимости вставлять HTML в комментарии,
используя Markdown.

LDoc также будет работать с кодом расширения Lua C и предоставляет несколько
удобных ярлыков.